<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>TurtleDB: ca.uqac.dim.turtledb.XmlQueryFormatter Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">TurtleDB
   
   </div>
   <div id="projectbrief">A mini distributed database system</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">ca.uqac.dim.turtledb.XmlQueryFormatter Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="ca::uqac::dim::turtledb::XmlQueryFormatter" -->
<p><a href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static Document&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html#a78948dd1a52df58aeca9a7088ab06a8d">toXmlDocument</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> q)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html#ad5f81fab61516198acd7e3b14d4327a1">toXmlString</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> q)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Facilities to convert relations into equivalent XML representations. The <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html">XmlQueryFormatter</a> works in pair with the <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_parser.html">XmlQueryParser</a>; more precisely, for any <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> <code>r</code>, we should have that <code> <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_parser.html#af45aba32674228c6538d7055ea6e0c6d">XmlQueryParser.parse</a>(XmlQueryFormatter.toXmlDocument(r)) == r </code> </p>
<dl class="author"><dt><b>Author:</b></dt><dd>sylvain </dd></dl>

<p>Definition at line <a class="el" href="_xml_query_formatter_8java_source.html#l00036">36</a> of file <a class="el" href="_xml_query_formatter_8java_source.html">XmlQueryFormatter.java</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a78948dd1a52df58aeca9a7088ab06a8d"></a><!-- doxytag: member="ca::uqac::dim::turtledb::XmlQueryFormatter::toXmlDocument" ref="a78948dd1a52df58aeca9a7088ab06a8d" args="(Relation q)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static Document <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html#a78948dd1a52df58aeca9a7088ab06a8d">ca.uqac.dim.turtledb.XmlQueryFormatter.toXmlDocument</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>q</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Serializes a relation as a DOM document. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">q</td><td>The relation to serialize </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting XML document </dd></dl>

<p>Definition at line <a class="el" href="_xml_query_formatter_8java_source.html#l00043">43</a> of file <a class="el" href="_xml_query_formatter_8java_source.html">XmlQueryFormatter.java</a>.</p>

</div>
</div>
<a class="anchor" id="ad5f81fab61516198acd7e3b14d4327a1"></a><!-- doxytag: member="ca::uqac::dim::turtledb::XmlQueryFormatter::toXmlString" ref="ad5f81fab61516198acd7e3b14d4327a1" args="(Relation q)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static String <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html#ad5f81fab61516198acd7e3b14d4327a1">ca.uqac.dim.turtledb.XmlQueryFormatter.toXmlString</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>q</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Serializes a relation as a string containing an XML representation of the relation. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">q</td><td>The relation to serialize </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A "stringified" XML document </dd></dl>

<p>Definition at line <a class="el" href="_xml_query_formatter_8java_source.html#l00063">63</a> of file <a class="el" href="_xml_query_formatter_8java_source.html">XmlQueryFormatter.java</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/ca/uqac/dim/turtledb/<a class="el" href="_xml_query_formatter_8java_source.html">XmlQueryFormatter.java</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceca.html">ca</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac.html">uqac</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac_1_1dim.html">dim</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac_1_1dim_1_1turtledb.html">turtledb</a>      </li>
      <li class="navelem"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_xml_query_formatter.html">XmlQueryFormatter</a>      </li>

    <li class="footer">Generated on Fri Dec 7 2012 18:55:40 for TurtleDB by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
